Foxit PDF SDK
FoxitPDFSDKPython3.FormXObject类 参考
类 FoxitPDFSDKPython3.FormXObject 继承关系图:
FoxitPDFSDKPython3.GraphicsObject

Public 成员函数

def GetGraphicsObjects ()
 获取与当前表单XObject关联的图形对象。 更多...
 
def GetStream ()
 获取流。 更多...
 
def ImportPageContent (source_page, is_annots_included)
 从指定的PDF页面将页面内容导入到当前表单XObject。 更多...
 
- Public 成员函数 继承自 FoxitPDFSDKPython3.GraphicsObject
def AddClipPath (path, fill_mode)
 添加用于裁剪的路径。 更多...
 
def AddClipTextObject (textobject)
 添加用于裁剪的文本对象。 更多...
 
def ClearClips ()
 清除所有裁剪。 更多...
 
def Clone ()
 克隆新的图形对象。 更多...
 
def GetBlendMode ()
 获取透明成像模型的混合模式。 更多...
 
def GetClipPath (index)
 根据索引获取路径裁剪。 更多...
 
def GetClipPathCount ()
 获取路径裁剪的数量。 更多...
 
def GetClipPathFillMode (index)
 根据索引获取路径裁剪的填充模式。 更多...
 
def GetClipRect ()
 获取裁剪矩形。 更多...
 
def GetClipTextObject (index)
 根据索引获取文本裁剪的文本对象。 更多...
 
def GetClipTextObjectCount ()
 获取文本裁剪的数量。 更多...
 
def GetColorState ()
 获取颜色状态。 更多...
 
def GetFillColor ()
 获取填充颜色。 更多...
 
def GetFillOpacity ()
 获取除描边外的绘制操作的不透明度值。 更多...
 
def GetFormXObject ()
 如果当前图形对象表示表单XObject对象,则获取表单XObject图形对象。 更多...
 
def GetGraphState ()
 获取图形状态。 更多...
 
def GetImageObject ()
 如果当前图形对象表示图像对象,则获取图像图形对象。 更多...
 
def GetLayers (layer_tree)
 获取与当前图形对象关联的所有图层。 更多...
 
def GetMarkedContent ()
 获取标记内容对象。 更多...
 
def GetMatrix ()
 获取矩阵。 更多...
 
def GetPathObject ()
 如果当前图形对象表示路径对象,则获取路径图形对象。 更多...
 
def GetRect ()
 获取当前图形对象的矩形。 更多...
 
def GetShadingObject ()
 如果当前图形对象表示阴影对象,则获取阴影图形对象。 更多...
 
def GetStrokeColor ()
 获取描边颜色。 更多...
 
def GetStrokeOpacity ()
 获取路径和字形轮廓的描边绘制操作的不透明度值。 更多...
 
def GetTextObject ()
 如果当前图形对象表示文本对象,则获取文本图形对象。 更多...
 
def GetType ()
 获取当前图形对象的类型。 更多...
 
def HasTransparency ()
 检查当前图形对象是否具有透明度。 更多...
 
def Release ()
 释放尚未插入到任何PDF页面中的克隆或新创建的PDF图形对象或其他对象。 更多...
 
def RemoveClipPath (index)
 根据索引删除路径裁剪。 更多...
 
def RemoveClipTextObject (index)
 根据索引删除用于裁剪的文本裁剪。 更多...
 
def Rotate (angle)
 从当前状态以指定的角度顺时针旋转当前图形对象。 更多...
 
def SetBlendMode (blend_mode)
 设置透明成像模型的混合模式。 更多...
 
def SetClipRect (clip_rect)
 设置裁剪矩形。 更多...
 
def SetColorState (color_state)
 设置颜色状态。 更多...
 
def SetFillColor (color)
 设置填充颜色。 更多...
 
def SetFillOpacity (opacity)
 设置除描边外的绘制操作的不透明度值。 更多...
 
def SetGraphState (graph_state)
 设置图形状态。 更多...
 
def SetMatrix (matrix)
 设置矩阵。 更多...
 
def SetStrokeColor (color)
 设置描边颜色。 更多...
 
def SetStrokeOpacity (opacity)
 设置路径和字形轮廓的描边绘制操作的不透明度值。 更多...
 
def Transform (matrix, need_transform_clippath)
 变换当前图形对象。 更多...
 

静态 Public 成员函数

def Create (document)
 创建新的表单XObject图形对象。 更多...
 

额外继承的成员函数

- 静态 Public 属性 继承自 FoxitPDFSDKPython3.GraphicsObject
 e_BlendColor = _fsdk.GraphicsObject_e_BlendColor
 使用源颜色的色调和饱和度以及背景颜色的明度创建颜色。 更多...
 
 e_BlendColorBurn = _fsdk.GraphicsObject_e_BlendColorBurn
 加深背景颜色以反映源颜色。 更多...
 
 e_BlendColorDodge = _fsdk.GraphicsObject_e_BlendColorDodge
 增亮背景颜色以反映源颜色。 更多...
 
 e_BlendDarken = _fsdk.GraphicsObject_e_BlendDarken
 选择背景和源颜色中较暗的一个。 更多...
 
 e_BlendDifference = _fsdk.GraphicsObject_e_BlendDifference
 从较亮的颜色中减去两种组成颜色中较暗的一种。 更多...
 
 e_BlendExclusion = _fsdk.GraphicsObject_e_BlendExclusion
 使用源颜色的色调和背景颜色的饱和度和明度创建颜色。 更多...
 
 e_BlendHardlight = _fsdk.GraphicsObject_e_BlendHardlight
 根据源颜色值进行相乘或滤色。 更多...
 
 e_BlendHue = _fsdk.GraphicsObject_e_BlendHue
 使用源颜色的色调和背景颜色的饱和度和明度创建颜色。 更多...
 
 e_BlendLighten = _fsdk.GraphicsObject_e_BlendLighten
 选择背景和源颜色中较亮的一个。 更多...
 
 e_BlendLuminosity = _fsdk.GraphicsObject_e_BlendLuminosity
 使用源颜色的明度和背景颜色的色调和饱和度创建颜色。 更多...
 
 e_BlendMultiply = _fsdk.GraphicsObject_e_BlendMultiply
 将背景与源颜色值相乘。 更多...
 
 e_BlendNormal = _fsdk.GraphicsObject_e_BlendNormal
 选择源颜色并忽略背景颜色。 更多...
 
 e_BlendOverlay = _fsdk.GraphicsObject_e_BlendOverlay
 根据背景颜色值进行相乘或滤色。 更多...
 
 e_BlendSaturation = _fsdk.GraphicsObject_e_BlendSaturation
 使用源颜色的饱和度和背景颜色的色调和明度创建颜色。 更多...
 
 e_BlendScreen = _fsdk.GraphicsObject_e_BlendScreen
 将背景的补码与源颜色值相乘,然后对结果取补。 更多...
 
 e_BlendSoftlight = _fsdk.GraphicsObject_e_BlendSoftlight
 根据源颜色值使颜色变暗或变亮。 更多...
 
 e_TypeAll = _fsdk.GraphicsObject_e_TypeAll
 表示所有图形对象类型,仅用作过滤器。
 
 e_TypeEmptyMarkedContent = _fsdk.GraphicsObject_e_TypeEmptyMarkedContent
 空标记内容对象。
 
 e_TypeFormXObject = _fsdk.GraphicsObject_e_TypeFormXObject
 表单XObject图形对象。
 
 e_TypeImage = _fsdk.GraphicsObject_e_TypeImage
 图像图形对象。
 
 e_TypeInlines = _fsdk.GraphicsObject_e_TypeInlines
 内联图形对象。
 
 e_TypePath = _fsdk.GraphicsObject_e_TypePath
 路径图形对象。
 
 e_TypeShading = _fsdk.GraphicsObject_e_TypeShading
 阴影图形对象。
 
 e_TypeText = _fsdk.GraphicsObject_e_TypeText
 文本图形对象。
 

详细描述

表单XObject不仅是图形对象,也是容器。表单XObject由一组图形对象或子表单XObject组成。 表单XObject是一种PDF图形对象,因此FoxitPDFSDKPython3.FormXObject 类派生自GraphicsObject 类。 它提供了获取/设置表单XObject数据的函数。
要创建新的表单XObject图形对象,请使用FoxitPDFSDKPython3.PathObject.Create 函数,然后 将页面内容导入到新的表单XObject中,或通过FoxitPDFSDKPython3.FormXObject.GetGraphicsObjects 函数 返回的FoxitPDFSDKPython3.GraphicsObjects 对象将新的图形对象插入到表单XObject中。

参见
GraphicsObject

成员函数说明

◆ Create()

FoxitPDFSDKPython3.FormXObject.Create (   document)
static

创建新的表单XObject图形对象。

新创建的表单XObject图形对象尚未包含任何数据。然后,可以调用设置函数 为新的表单XObject图形对象设置数据。 如果新创建的表单XObject不会插入到任何页面或其他对象中, 请记住在不使用时调用FoxitPDFSDKPython3.GraphicsObject.Release 函数来释放它。

参数
[in]document有效的PDF文档对象。新的表单XObject图形对象随后应插入到 此PDF文档的某个页面中。
返回
新的表单XObject。如果有任何错误,此函数将返回null

◆ GetGraphicsObjects()

def FoxitPDFSDKPython3.FormXObject.GetGraphicsObjects ( )

获取与当前表单XObject关联的图形对象。

返回
FoxitPDFSDKPython3.GraphicsObjects 对象。

◆ GetStream()

def FoxitPDFSDKPython3.FormXObject.GetStream ( )

获取流。

返回
表示当前表单XObject流数据的FoxitPDFSDKPython3.PDFStream 。 如果有任何错误,此函数将返回null

◆ ImportPageContent()

def FoxitPDFSDKPython3.FormXObject.ImportPageContent (   source_page,
  is_annots_included 
)

从指定的PDF页面将页面内容导入到当前表单XObject。

如果此函数成功,当前表单XObject的边界框将与页面大小相同。

参数
[in]source_page有效的PDF页面对象,表示其内容将被 导入到当前表单XObject的源PDF页面。
[in]is_annots_includedtrue 表示注释应与参数source_page的内容一起包含。 false 表示注释应从参数source_page的内容中忽略。
返回
true 表示成功,false 表示失败。
注解
当此函数成功时,应调用FoxitPDFSDKPython3.GraphicsObjects.GenerateContent 函数。 更多详细信息请参阅FoxitPDFSDKPython3.GraphicsObjects.GenerateContent 函数。